<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen; http://apigen.org" />
	<meta name="robots" content="noindex" />

	<title>Web\IHttpRequest.php</title>

	<link rel="stylesheet" href="resources/style.css?v=2011071314" type="text/css" media="all" />
	<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" />
	<link rel="search" href="opensearch.xml" type="application/opensearchdescription+xml" title="Nette Framework API documentation" />
	<script type="text/javascript" src="resources/combined.js"></script>
	<script type="text/javascript" src="allclasses.js"></script>
</head>

<body>
<div id="left">
	<a href="allclasses.html">All Classes</a>

	<h3>Namespaces</h3>
	<ul>
		<li><a href="namespace-none.html">none</a>
		</li>
		<li><a href="namespace-Nette.html">Nette</a>
		</li>
		<li><a href="namespace-Nette.Application.html">Nette\Application</a>
		</li>
		<li><a href="namespace-Nette.Caching.html">Nette\Caching</a>
		</li>
		<li><a href="namespace-Nette.Collections.html">Nette\Collections</a>
		</li>
		<li><a href="namespace-Nette.Config.html">Nette\Config</a>
		</li>
		<li><a href="namespace-Nette.Forms.html">Nette\Forms</a>
		</li>
		<li><a href="namespace-Nette.IO.html">Nette\IO</a>
		</li>
		<li><a href="namespace-Nette.Loaders.html">Nette\Loaders</a>
		</li>
		<li><a href="namespace-Nette.Mail.html">Nette\Mail</a>
		</li>
		<li><a href="namespace-Nette.Reflection.html">Nette\Reflection</a>
		</li>
		<li><a href="namespace-Nette.Security.html">Nette\Security</a>
		</li>
		<li><a href="namespace-Nette.Templates.html">Nette\Templates</a>
		</li>
		<li class="active"><a href="namespace-Nette.Web.html">Nette\Web</a>
		</li>
		<li><a href="namespace-PHP.html">PHP</a>
		</li>
	</ul>

	<hr />

	<h3>Classes</h3>

	<ul>
		<li><a href="Nette.Web.Ftp.html">Ftp</a></li>
		<li><a href="Nette.Web.Html.html">Html</a></li>
		<li><a href="Nette.Web.HttpContext.html">HttpContext</a></li>
		<li><a href="Nette.Web.HttpRequest.html">HttpRequest</a></li>
		<li><a href="Nette.Web.HttpResponse.html">HttpResponse</a></li>
		<li><a href="Nette.Web.HttpUploadedFile.html">HttpUploadedFile</a></li>
		<li><a href="Nette.Web.Session.html">Session</a></li>
		<li><a href="Nette.Web.SessionNamespace.html">SessionNamespace</a></li>
		<li><a href="Nette.Web.Uri.html">Uri</a></li>
		<li><a href="Nette.Web.UriScript.html">UriScript</a></li>
		<li><a href="Nette.Web.User.html">User</a></li>
	</ul>

	<h3>Interfaces</h3>

	<ul>
		<li class="active"><a href="Nette.Web.IHttpRequest.html">IHttpRequest</a></li>
		<li><a href="Nette.Web.IHttpResponse.html">IHttpResponse</a></li>
		<li><a href="Nette.Web.IUser.html">IUser</a></li>
	</ul>

	<h3>Exceptions</h3>

	<ul>
		<li><a href="Nette.Web.FtpException.html">FtpException</a></li>
	</ul>
</div>

<div id="right">
	<form action="http://www.google.com/cse" id="search" onsubmit="if(this.q.value.indexOf('more:')==-1)this.q.value+=' more:api'">
		<input type="hidden" name="cx" value="011549293477758430224:vxofa9ufnhc" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" class="text" /><input type="submit" value="Search" />
	</form>

<div id="navigation">
	<ul>
		<li><a href="overview.html" title="Summary of all namespaces">Overview</a></li>
		<li><a href="elements.html">Elements</a></li>
	</ul>
</div>

<pre><code><a href="#1" id="1" class="l">  1: </a><span class="xlang">&lt;?php</span>
<a href="#2" id="2" class="l">  2: </a>
<a href="#3" id="3" class="l">  3: </a><span class="php-comment">/**
</span><a href="#4" id="4" class="l">  4: </a><span class="php-comment"> * This file is part of the Nette Framework (http://nette.org)
</span><a href="#5" id="5" class="l">  5: </a><span class="php-comment"> *
</span><a href="#6" id="6" class="l">  6: </a><span class="php-comment"> * Copyright (c) 2004, 2010 David Grudl (http://davidgrudl.com)
</span><a href="#7" id="7" class="l">  7: </a><span class="php-comment"> *
</span><a href="#8" id="8" class="l">  8: </a><span class="php-comment"> * For the full copyright and license information, please view
</span><a href="#9" id="9" class="l">  9: </a><span class="php-comment"> * the file license.txt that was distributed with this source code.
</span><a href="#10" id="10" class="l"> 10: </a><span class="php-comment"> */</span>
<a href="#11" id="11" class="l"> 11: </a>
<a href="#12" id="12" class="l"> 12: </a><span class="php-keyword1">namespace</span> Nette\Web;
<a href="#13" id="13" class="l"> 13: </a>
<a href="#14" id="14" class="l"> 14: </a><span class="php-keyword1">use</span> Nette;
<a href="#15" id="15" class="l"> 15: </a>
<a href="#16" id="16" class="l"> 16: </a>
<a href="#17" id="17" class="l"> 17: </a>
<a href="#18" id="18" class="l"> 18: </a><span class="php-comment">/**
</span><a href="#19" id="19" class="l"> 19: </a><span class="php-comment"> * IHttpRequest provides access scheme for request sent via HTTP.
</span><a href="#20" id="20" class="l"> 20: </a><span class="php-comment"> *
</span><a href="#21" id="21" class="l"> 21: </a><span class="php-comment"> * @author     David Grudl
</span><a href="#22" id="22" class="l"> 22: </a><span class="php-comment"> */</span>
<a href="#23" id="23" class="l"> 23: </a><span class="php-keyword1">interface</span> IHttpRequest
<a href="#24" id="24" class="l"> 24: </a>{
<a href="#25" id="25" class="l"> 25: </a>    <span class="php-comment">/**#@+ HTTP request method */</span>
<a href="#26" id="26" class="l"> 26: </a>    <span class="php-keyword1">const</span>
<a href="#27" id="27" class="l"> 27: </a>        GET = <span class="php-quote">'GET'</span>,
<a href="#28" id="28" class="l"> 28: </a>        POST = <span class="php-quote">'POST'</span>,
<a href="#29" id="29" class="l"> 29: </a>        HEAD = <span class="php-quote">'HEAD'</span>,
<a href="#30" id="30" class="l"> 30: </a>        PUT = <span class="php-quote">'PUT'</span>,
<a href="#31" id="31" class="l"> 31: </a>        DELETE = <span class="php-quote">'DELETE'</span>;
<a href="#32" id="32" class="l"> 32: </a>    <span class="php-comment">/**#@-*/</span>
<a href="#33" id="33" class="l"> 33: </a>
<a href="#34" id="34" class="l"> 34: </a>    <span class="php-comment">/**
</span><a href="#35" id="35" class="l"> 35: </a><span class="php-comment">     * Returns URL object.
</span><a href="#36" id="36" class="l"> 36: </a><span class="php-comment">     * @return UriScript
</span><a href="#37" id="37" class="l"> 37: </a><span class="php-comment">     */</span>
<a href="#38" id="38" class="l"> 38: </a>    <span class="php-keyword1">function</span> getUri();
<a href="#39" id="39" class="l"> 39: </a>
<a href="#40" id="40" class="l"> 40: </a>    <span class="php-comment">/********************* query, post, files &amp; cookies ****************d*g**/</span>
<a href="#41" id="41" class="l"> 41: </a>
<a href="#42" id="42" class="l"> 42: </a>    <span class="php-comment">/**
</span><a href="#43" id="43" class="l"> 43: </a><span class="php-comment">     * Returns variable provided to the script via URL query ($_GET).
</span><a href="#44" id="44" class="l"> 44: </a><span class="php-comment">     * If no key is passed, returns the entire array.
</span><a href="#45" id="45" class="l"> 45: </a><span class="php-comment">     * @param  string key
</span><a href="#46" id="46" class="l"> 46: </a><span class="php-comment">     * @param  mixed  default value
</span><a href="#47" id="47" class="l"> 47: </a><span class="php-comment">     * @return mixed
</span><a href="#48" id="48" class="l"> 48: </a><span class="php-comment">     */</span>
<a href="#49" id="49" class="l"> 49: </a>    <span class="php-keyword1">function</span> getQuery(<span class="php-var">$key</span> = <span class="php-keyword1">NULL</span>, <span class="php-var">$default</span> = <span class="php-keyword1">NULL</span>);
<a href="#50" id="50" class="l"> 50: </a>
<a href="#51" id="51" class="l"> 51: </a>    <span class="php-comment">/**
</span><a href="#52" id="52" class="l"> 52: </a><span class="php-comment">     * Returns variable provided to the script via POST method ($_POST).
</span><a href="#53" id="53" class="l"> 53: </a><span class="php-comment">     * If no key is passed, returns the entire array.
</span><a href="#54" id="54" class="l"> 54: </a><span class="php-comment">     * @param  string key
</span><a href="#55" id="55" class="l"> 55: </a><span class="php-comment">     * @param  mixed  default value
</span><a href="#56" id="56" class="l"> 56: </a><span class="php-comment">     * @return mixed
</span><a href="#57" id="57" class="l"> 57: </a><span class="php-comment">     */</span>
<a href="#58" id="58" class="l"> 58: </a>    <span class="php-keyword1">function</span> getPost(<span class="php-var">$key</span> = <span class="php-keyword1">NULL</span>, <span class="php-var">$default</span> = <span class="php-keyword1">NULL</span>);
<a href="#59" id="59" class="l"> 59: </a>
<a href="#60" id="60" class="l"> 60: </a>    <span class="php-comment">/**
</span><a href="#61" id="61" class="l"> 61: </a><span class="php-comment">     * Returns HTTP POST data in raw format (only for &quot;application/x-www-form-urlencoded&quot;).
</span><a href="#62" id="62" class="l"> 62: </a><span class="php-comment">     * @return string
</span><a href="#63" id="63" class="l"> 63: </a><span class="php-comment">     */</span>
<a href="#64" id="64" class="l"> 64: </a>    <span class="php-keyword1">function</span> getPostRaw();
<a href="#65" id="65" class="l"> 65: </a>
<a href="#66" id="66" class="l"> 66: </a>    <span class="php-comment">/**
</span><a href="#67" id="67" class="l"> 67: </a><span class="php-comment">     * Returns uploaded file.
</span><a href="#68" id="68" class="l"> 68: </a><span class="php-comment">     * @param  string key (or more keys)
</span><a href="#69" id="69" class="l"> 69: </a><span class="php-comment">     * @return HttpUploadedFile
</span><a href="#70" id="70" class="l"> 70: </a><span class="php-comment">     */</span>
<a href="#71" id="71" class="l"> 71: </a>    <span class="php-keyword1">function</span> getFile(<span class="php-var">$key</span>);
<a href="#72" id="72" class="l"> 72: </a>
<a href="#73" id="73" class="l"> 73: </a>    <span class="php-comment">/**
</span><a href="#74" id="74" class="l"> 74: </a><span class="php-comment">     * Returns uploaded files.
</span><a href="#75" id="75" class="l"> 75: </a><span class="php-comment">     * @return array
</span><a href="#76" id="76" class="l"> 76: </a><span class="php-comment">     */</span>
<a href="#77" id="77" class="l"> 77: </a>    <span class="php-keyword1">function</span> getFiles();
<a href="#78" id="78" class="l"> 78: </a>
<a href="#79" id="79" class="l"> 79: </a>    <span class="php-comment">/**
</span><a href="#80" id="80" class="l"> 80: </a><span class="php-comment">     * Returns variable provided to the script via HTTP cookies.
</span><a href="#81" id="81" class="l"> 81: </a><span class="php-comment">     * @param  string key
</span><a href="#82" id="82" class="l"> 82: </a><span class="php-comment">     * @param  mixed  default value
</span><a href="#83" id="83" class="l"> 83: </a><span class="php-comment">     * @return mixed
</span><a href="#84" id="84" class="l"> 84: </a><span class="php-comment">     */</span>
<a href="#85" id="85" class="l"> 85: </a>    <span class="php-keyword1">function</span> getCookie(<span class="php-var">$key</span>, <span class="php-var">$default</span> = <span class="php-keyword1">NULL</span>);
<a href="#86" id="86" class="l"> 86: </a>
<a href="#87" id="87" class="l"> 87: </a>    <span class="php-comment">/**
</span><a href="#88" id="88" class="l"> 88: </a><span class="php-comment">     * Returns variables provided to the script via HTTP cookies.
</span><a href="#89" id="89" class="l"> 89: </a><span class="php-comment">     * @return array
</span><a href="#90" id="90" class="l"> 90: </a><span class="php-comment">     */</span>
<a href="#91" id="91" class="l"> 91: </a>    <span class="php-keyword1">function</span> getCookies();
<a href="#92" id="92" class="l"> 92: </a>
<a href="#93" id="93" class="l"> 93: </a>    <span class="php-comment">/********************* method &amp; headers ****************d*g**/</span>
<a href="#94" id="94" class="l"> 94: </a>
<a href="#95" id="95" class="l"> 95: </a>    <span class="php-comment">/**
</span><a href="#96" id="96" class="l"> 96: </a><span class="php-comment">     * Returns HTTP request method (GET, POST, HEAD, PUT, ...). The method is case-sensitive.
</span><a href="#97" id="97" class="l"> 97: </a><span class="php-comment">     * @return string
</span><a href="#98" id="98" class="l"> 98: </a><span class="php-comment">     */</span>
<a href="#99" id="99" class="l"> 99: </a>    <span class="php-keyword1">function</span> getMethod();
<a href="#100" id="100" class="l">100: </a>
<a href="#101" id="101" class="l">101: </a>    <span class="php-comment">/**
</span><a href="#102" id="102" class="l">102: </a><span class="php-comment">     * Checks HTTP request method.
</span><a href="#103" id="103" class="l">103: </a><span class="php-comment">     * @param  string
</span><a href="#104" id="104" class="l">104: </a><span class="php-comment">     * @return bool
</span><a href="#105" id="105" class="l">105: </a><span class="php-comment">     */</span>
<a href="#106" id="106" class="l">106: </a>    <span class="php-keyword1">function</span> isMethod(<span class="php-var">$method</span>);
<a href="#107" id="107" class="l">107: </a>
<a href="#108" id="108" class="l">108: </a>    <span class="php-comment">/**
</span><a href="#109" id="109" class="l">109: </a><span class="php-comment">     * Return the value of the HTTP header. Pass the header name as the
</span><a href="#110" id="110" class="l">110: </a><span class="php-comment">     * plain, HTTP-specified header name (e.g. 'Accept-Encoding').
</span><a href="#111" id="111" class="l">111: </a><span class="php-comment">     * @param  string
</span><a href="#112" id="112" class="l">112: </a><span class="php-comment">     * @param  mixed
</span><a href="#113" id="113" class="l">113: </a><span class="php-comment">     * @return mixed
</span><a href="#114" id="114" class="l">114: </a><span class="php-comment">     */</span>
<a href="#115" id="115" class="l">115: </a>    <span class="php-keyword1">function</span> getHeader(<span class="php-var">$header</span>, <span class="php-var">$default</span> = <span class="php-keyword1">NULL</span>);
<a href="#116" id="116" class="l">116: </a>
<a href="#117" id="117" class="l">117: </a>    <span class="php-comment">/**
</span><a href="#118" id="118" class="l">118: </a><span class="php-comment">     * Returns all HTTP headers.
</span><a href="#119" id="119" class="l">119: </a><span class="php-comment">     * @return array
</span><a href="#120" id="120" class="l">120: </a><span class="php-comment">     */</span>
<a href="#121" id="121" class="l">121: </a>    <span class="php-keyword1">function</span> getHeaders();
<a href="#122" id="122" class="l">122: </a>
<a href="#123" id="123" class="l">123: </a>    <span class="php-comment">/**
</span><a href="#124" id="124" class="l">124: </a><span class="php-comment">     * Is the request is sent via secure channel (https).
</span><a href="#125" id="125" class="l">125: </a><span class="php-comment">     * @return bool
</span><a href="#126" id="126" class="l">126: </a><span class="php-comment">     */</span>
<a href="#127" id="127" class="l">127: </a>    <span class="php-keyword1">function</span> isSecured();
<a href="#128" id="128" class="l">128: </a>
<a href="#129" id="129" class="l">129: </a>    <span class="php-comment">/**
</span><a href="#130" id="130" class="l">130: </a><span class="php-comment">     * Is AJAX request?
</span><a href="#131" id="131" class="l">131: </a><span class="php-comment">     * @return bool
</span><a href="#132" id="132" class="l">132: </a><span class="php-comment">     */</span>
<a href="#133" id="133" class="l">133: </a>    <span class="php-keyword1">function</span> isAjax();
<a href="#134" id="134" class="l">134: </a>
<a href="#135" id="135" class="l">135: </a>    <span class="php-comment">/**
</span><a href="#136" id="136" class="l">136: </a><span class="php-comment">     * Returns the IP address of the remote client.
</span><a href="#137" id="137" class="l">137: </a><span class="php-comment">     * @return string
</span><a href="#138" id="138" class="l">138: </a><span class="php-comment">     */</span>
<a href="#139" id="139" class="l">139: </a>    <span class="php-keyword1">function</span> getRemoteAddress();
<a href="#140" id="140" class="l">140: </a>
<a href="#141" id="141" class="l">141: </a>    <span class="php-comment">/**
</span><a href="#142" id="142" class="l">142: </a><span class="php-comment">     * Returns the host of the remote client.
</span><a href="#143" id="143" class="l">143: </a><span class="php-comment">     * @return string
</span><a href="#144" id="144" class="l">144: </a><span class="php-comment">     */</span>
<a href="#145" id="145" class="l">145: </a>    <span class="php-keyword1">function</span> getRemoteHost();
<a href="#146" id="146" class="l">146: </a>
<a href="#147" id="147" class="l">147: </a>}
<a href="#148" id="148" class="l">148: </a></code></pre>

	<div id="footer">
		Nette Framework API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</body>
</html>
